Order Feasibility API

(0 reviews)

How to use the API

Here is an overview of the features included in this API, what they do and what you can use them for.

API Feature	What it does	What it’s used for
Get API Version	Retrieve API asset full version number (major, minor and patch version numbers).	Viewing the API version.
Request Order Feasibility	Queries order feasibility based off Place ID, order type, product offer and CSE product offer.	Validating if an order is feasible at an address or location.

Feasibility reasons and codes

The following feasibility codes may be provided:

Feasibility code	Description
999	Placing the order will require manual activity by Chorus, it is not feasible in its current state.
998	The order is feasible and can be submitted to initiate provisioning.
997	Closed, the feasibility check shows that placing the order is not possible.
996	This reason code could not be returned by the web service.

The following feasibility reasons may be provided:

Feasibility reason	Feasibility code
Order Not feasible (default reason when no specific reason exists).	999
Consent declined in the location. Request Manual Feasibility to proceed, if required.	999
Fibre is not available in the location. Request Manual Feasibility to proceed, if required.	999
Feasibility request requires manual investigation.	999
Feasible to Order (default reason when no specific reason exists).	998
Design and Build is required if Customer Order is submitted for this location.	998
Consent is required if Customer Order is submitted.	998
Feasible to Provide Service at Location. Select an appointment to proceed to Customer Order.	998
Your order is feasible at the given location, please select an RFS date.	998
Hyperfibre Design and Build is required before appointment selection if Customer Order is submitted for this location.	998
Order Not Feasible (default reason when no specific reason exists).	997
Product Instance has inflight order, you will need to cancel any inflight orders against the product and try again.	997
The same ONT has inflight product order, you will need to cancel any inflight orders first and then try again.	997
Replace Product Instance has inflight order, you will need to cancel any inflight orders against product and try again.	997
Insufficient resources available.	997
Product Instance does not exist at specified location.	997
Invalid address or location.	997
Customer not onboarded for requested Product Offer.	997
The Product Instance provided belongs to a different customer.	997
Unbundled services are not available at this location.	997
Cannot transfer a Product Instance ID that already belongs to customer placing order.	997
No existing instances, try Move Primary Offer.	997
Aim requires an offering.	997
Unknown aim / order type combination.	997
Aim requires a product offering.	997
Aim requires a Product Instance.	997
Unknown location.	997
No existing instances, try Connect Primary Offer.	997
There are available ONT's or no ONT exists, try Connect Primary.	997
No suitable ONT is available.	997
Supplied ONT ID is not valid.	997
ONT ID and TLC combination is not valid.	997
Request validation failed: Primary Product Instance is not supplied or incompatible with supplied ONT ID.	997
Product characteristic does not belong to product offer.	997
Request validation failed: Characteristic [name: X, value: Y] out of range.	997
No existing primary instance for Connect Secondary.	997
Request validation failed: Primary Product Instance is not supplied.	997
Contact details incorrect.	997
Existing open order.	997
Invalid order type.	997
Invalid Product ID.	997
Invalid Provider name given for Transfer.	997
Invalid address or location.	997
Fibre not yet available at this location.	997
Invalid or non-existing POI.	997
Resources not available.	997
Your order is not feasible. Please try again later.	997
Losing Service Provider Name is invalid.	997
Handover Connection not available.	997
The current ONT mode does not support this.	997
No free suitable ports are available to support this request.	997
No existing primary instance for Connect Secondary.	997
Feasibility has Expired. Please submit another one for this Location.	996

siteVisitRequired

The following values are provided by the type element:

Value	Description
true	Site Visit is required for the request, you will be required to book a site visit for the order to progress.
false	Site Visit isn’t required for the request.
not yet identified (this is indicated by the absence of the attribute in the response)	Site Visit is yet to be determined.

SiteVisit - bookable

The bookable indicator setting is determined by the order feasibility result.

The following values are provided by the SiteVisit - bookable element:

Value	Description
true	Site visit appointment can be booked. If this value is returned indicated prior to CreateOrder, it indicates the appointment must be in a reserved condition at the time we receive the CreateOrder request.
false	Site visit appointment cannot be booked at this time. Note: If this value is returned prior to CreateOrder, it indicates the appointment cannot be reserved before CreateOrder is submitted. We will use the Notification touchpoint after the order submission to request that you book appointments when required.

SiteVisit - type